<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>XenC: XenVocab Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">XenC
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">Open-source tool for data selection in NLP</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_xen_vocab-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">XenVocab Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Class handling a XenC vocabulary.  
 <a href="class_xen_vocab.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="xenvocab_8h_source.html">xenvocab.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af54680a48388c410d6119bb13e9a3019"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_vocab.html#af54680a48388c410d6119bb13e9a3019">XenVocab</a> ()</td></tr>
<tr class="memdesc:af54680a48388c410d6119bb13e9a3019"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#af54680a48388c410d6119bb13e9a3019">More...</a><br /></td></tr>
<tr class="separator:af54680a48388c410d6119bb13e9a3019"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbb209737cf301764e5c110f35f487ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_vocab.html#adbb209737cf301764e5c110f35f487ef">initialize</a> (boost::shared_ptr&lt; <a class="el" href="class_xen_file.html">XenFile</a> &gt; ptrFile)</td></tr>
<tr class="memdesc:adbb209737cf301764e5c110f35f487ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization function from an already instantiated <a class="el" href="class_xen_file.html" title="Class providing some basic functions around files. ">XenFile</a>.  <a href="#adbb209737cf301764e5c110f35f487ef">More...</a><br /></td></tr>
<tr class="separator:adbb209737cf301764e5c110f35f487ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46654e58adf192668637404f277fd5e5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_vocab.html#a46654e58adf192668637404f277fd5e5">initialize</a> (boost::shared_ptr&lt; <a class="el" href="class_corpus.html">Corpus</a> &gt; ptrCorp)</td></tr>
<tr class="memdesc:a46654e58adf192668637404f277fd5e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization function from a <a class="el" href="class_corpus.html" title="Corpus-related functionalities. ">Corpus</a>.  <a href="#a46654e58adf192668637404f277fd5e5">More...</a><br /></td></tr>
<tr class="separator:a46654e58adf192668637404f277fd5e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a5fb3a986880f9ba773c71d20582557"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_vocab.html#a2a5fb3a986880f9ba773c71d20582557">initialize</a> (boost::shared_ptr&lt; <a class="el" href="class_corpus.html">Corpus</a> &gt; ptrInCorp, boost::shared_ptr&lt; <a class="el" href="class_corpus.html">Corpus</a> &gt; ptrOutCorp)</td></tr>
<tr class="memdesc:a2a5fb3a986880f9ba773c71d20582557"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization function from two <a class="el" href="class_corpus.html" title="Corpus-related functionalities. ">Corpus</a>.  <a href="#a2a5fb3a986880f9ba773c71d20582557">More...</a><br /></td></tr>
<tr class="separator:a2a5fb3a986880f9ba773c71d20582557"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53227b7f5482e32f4c99bcfe9039a2dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_vocab.html#a53227b7f5482e32f4c99bcfe9039a2dd">initialize</a> (boost::shared_ptr&lt; <a class="el" href="class_xen_result.html">XenResult</a> &gt; ptrXenRes)</td></tr>
<tr class="memdesc:a53227b7f5482e32f4c99bcfe9039a2dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization function from a sorted result file.  <a href="#a53227b7f5482e32f4c99bcfe9039a2dd">More...</a><br /></td></tr>
<tr class="separator:a53227b7f5482e32f4c99bcfe9039a2dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb0d61023c1101b317feb1b7e30da96e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_vocab.html#acb0d61023c1101b317feb1b7e30da96e">~XenVocab</a> ()</td></tr>
<tr class="memdesc:acb0d61023c1101b317feb1b7e30da96e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#acb0d61023c1101b317feb1b7e30da96e">More...</a><br /></td></tr>
<tr class="separator:acb0d61023c1101b317feb1b7e30da96e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11690619c4c7b03e143a07952ab32db7"><td class="memItemLeft" align="right" valign="top">std::map&lt; std::string, int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_vocab.html#a11690619c4c7b03e143a07952ab32db7">getXenVocab</a> () const </td></tr>
<tr class="memdesc:a11690619c4c7b03e143a07952ab32db7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to the XenC vocabulary object.  <a href="#a11690619c4c7b03e143a07952ab32db7">More...</a><br /></td></tr>
<tr class="separator:a11690619c4c7b03e143a07952ab32db7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9a700866d77909b166a42c74bc97e47"><td class="memItemLeft" align="right" valign="top">boost::shared_ptr&lt; <a class="el" href="class_xen_file.html">XenFile</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_vocab.html#ab9a700866d77909b166a42c74bc97e47">getXenFile</a> () const </td></tr>
<tr class="memdesc:ab9a700866d77909b166a42c74bc97e47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to the vocabulary file.  <a href="#ab9a700866d77909b166a42c74bc97e47">More...</a><br /></td></tr>
<tr class="separator:ab9a700866d77909b166a42c74bc97e47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9579b0e9fcc7d5a3fe71f12e55c531cd"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_xen_vocab.html#a9579b0e9fcc7d5a3fe71f12e55c531cd">getSize</a> () const </td></tr>
<tr class="memdesc:a9579b0e9fcc7d5a3fe71f12e55c531cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to the size of the vocabulary text.  <a href="#a9579b0e9fcc7d5a3fe71f12e55c531cd">More...</a><br /></td></tr>
<tr class="separator:a9579b0e9fcc7d5a3fe71f12e55c531cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class handling a XenC vocabulary. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af54680a48388c410d6119bb13e9a3019"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XenVocab::XenVocab </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default constructor. </p>

</div>
</div>
<a class="anchor" id="acb0d61023c1101b317feb1b7e30da96e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XenVocab::~XenVocab </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9579b0e9fcc7d5a3fe71f12e55c531cd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int XenVocab::getSize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Accessor to the size of the vocabulary text. </p>
<dl class="section return"><dt>Returns</dt><dd>the size of the vocabulary text </dd></dl>

</div>
</div>
<a class="anchor" id="ab9a700866d77909b166a42c74bc97e47"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boost::shared_ptr&lt; <a class="el" href="class_xen_file.html">XenFile</a> &gt; XenVocab::getXenFile </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Accessor to the vocabulary file. </p>
<dl class="section return"><dt>Returns</dt><dd>the vocabulary file </dd></dl>

</div>
</div>
<a class="anchor" id="a11690619c4c7b03e143a07952ab32db7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::map&lt; std::string, int &gt; XenVocab::getXenVocab </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Accessor to the XenC vocabulary object. </p>
<dl class="section return"><dt>Returns</dt><dd>the XenC vocabulary object </dd></dl>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_xen_vocab_a11690619c4c7b03e143a07952ab32db7_cgraph.png" border="0" usemap="#class_xen_vocab_a11690619c4c7b03e143a07952ab32db7_cgraph" alt=""/></div>
<map name="class_xen_vocab_a11690619c4c7b03e143a07952ab32db7_cgraph" id="class_xen_vocab_a11690619c4c7b03e143a07952ab32db7_cgraph">
<area shape="rect" id="node2" href="class_xen_i_o.html#ac7f7d85d888d510c21ddf217840e20ba" title="Writes a vocab to file. " alt="" coords="222,5,354,31"/>
<area shape="rect" id="node3" href="class_xen_i_o.html#ad087c0895d023a9ff0c0a1f794854b5d" title="Reads a file (plain text/gzipped) " alt="" coords="241,55,335,80"/>
<area shape="rect" id="node4" href="struct_xen_common_1_1_xen_c_eption.html#a32ca1dc358f84de4e63d73c72e318c42" title="Accessor to the exception message. " alt="" coords="402,48,580,87"/>
</map>
</div>
</p>

</div>
</div>
<a class="anchor" id="adbb209737cf301764e5c110f35f487ef"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XenVocab::initialize </td>
          <td>(</td>
          <td class="paramtype">boost::shared_ptr&lt; <a class="el" href="class_xen_file.html">XenFile</a> &gt;&#160;</td>
          <td class="paramname"><em>ptrFile</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialization function from an already instantiated <a class="el" href="class_xen_file.html" title="Class providing some basic functions around files. ">XenFile</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ptrFile</td><td>: the vocabulary file </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a46654e58adf192668637404f277fd5e5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XenVocab::initialize </td>
          <td>(</td>
          <td class="paramtype">boost::shared_ptr&lt; <a class="el" href="class_corpus.html">Corpus</a> &gt;&#160;</td>
          <td class="paramname"><em>ptrCorp</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialization function from a <a class="el" href="class_corpus.html" title="Corpus-related functionalities. ">Corpus</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ptrCorp</td><td>: the <a class="el" href="class_corpus.html" title="Corpus-related functionalities. ">Corpus</a> to extract the vocabulary from </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a2a5fb3a986880f9ba773c71d20582557"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XenVocab::initialize </td>
          <td>(</td>
          <td class="paramtype">boost::shared_ptr&lt; <a class="el" href="class_corpus.html">Corpus</a> &gt;&#160;</td>
          <td class="paramname"><em>ptrInCorp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">boost::shared_ptr&lt; <a class="el" href="class_corpus.html">Corpus</a> &gt;&#160;</td>
          <td class="paramname"><em>ptrOutCorp</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialization function from two <a class="el" href="class_corpus.html" title="Corpus-related functionalities. ">Corpus</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ptrInCorp</td><td>: the in-domain <a class="el" href="class_corpus.html" title="Corpus-related functionalities. ">Corpus</a> to extract the vocabulary from </td></tr>
    <tr><td class="paramname">ptrOutCorp</td><td>: the out-of-domain <a class="el" href="class_corpus.html" title="Corpus-related functionalities. ">Corpus</a> to extract the vocabulary from </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a53227b7f5482e32f4c99bcfe9039a2dd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XenVocab::initialize </td>
          <td>(</td>
          <td class="paramtype">boost::shared_ptr&lt; <a class="el" href="class_xen_result.html">XenResult</a> &gt;&#160;</td>
          <td class="paramname"><em>ptrXenRes</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialization function from a sorted result file. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ptrXenRes</td><td>: the sorted result file to extract the vocabulary from </td></tr>
  </table>
  </dd>
</dl>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_xen_vocab_a53227b7f5482e32f4c99bcfe9039a2dd_cgraph.png" border="0" usemap="#class_xen_vocab_a53227b7f5482e32f4c99bcfe9039a2dd_cgraph" alt=""/></div>
<map name="class_xen_vocab_a53227b7f5482e32f4c99bcfe9039a2dd_cgraph" id="class_xen_vocab_a53227b7f5482e32f4c99bcfe9039a2dd_cgraph">
<area shape="rect" id="node2" href="class_xen_option.html#a97ad096aee729b4d8ae993b1381d4eec" title="Accessor to the instance of the singleton XenOption object. " alt="" coords="190,5,351,31"/>
<area shape="rect" id="node3" href="class_xen_option.html#a9886771703c5b8866be587f50193ac9d" title="Accessor to the source language. " alt="" coords="196,55,345,80"/>
</map>
</div>
</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="xenvocab_8h_source.html">xenvocab.h</a></li>
<li>src/<a class="el" href="xenvocab_8cpp.html">xenvocab.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 18 2016 17:22:37 for XenC by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
